[RFR] Documentation for the Ldap component #6402

csarrazi · 2016-03-27T23:24:09Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	2.8, 3.0
Fixed tickets	#6201 #5756

javiereguiluz · 2016-03-29T09:48:47Z

@csarrazi thanks for this!! Bootstrapping documentation for a new component is very hard ... but at the same time very much appreciated!

I have a global question about the proposed docs. Sometimes you write LDAP server but most of the times you write Ldap server. Wikipedia always uses LDAP as an acronym. I propose to do the same ... except when referring to the name of the component, which apparently is Ldap. Thanks!

javiereguiluz · 2016-03-29T09:50:32Z

components/ldap.rst

+The Ldap Component
+==================
+
+    The Ldap component provides a means to connect to an Ldap server (OpenLdap or Active Directory).


This description should be very concise, so you did it great. However, if this component adds LDAP support to the Symfony Security component, maybe we should mention it. Right now it looks like this component is stand-alone and not integrated with Symfony security.

The component is indeed standalone. The security component actually is the one which integrates LDAP functionality in Symfony.

Oh, and I'm actually currently writing the doc for the Security component, too, which is why the PR is still WIP.

csarrazi · 2016-03-29T12:57:19Z

@javiereguiluz Yes, that's what is intended. However, as I wrote this quite late in the evening, I wasn't very consistent. Same thing with a / an before LDAP.

csarrazi · 2016-03-31T16:46:41Z

Still needs to pass on all files to normalize Ldap <-> LDAP, and a -> an.

Also, cookbook/security/ldap.rst still needs some more work (the examples still need to be adapted, I only added stubs for now).

linaori · 2016-04-13T06:55:44Z

Is there anything left to do on this PR? We're in the progress of updating our applications to Symfony 3 and the ldap packages used do not support 3.0 thus we will have to implement our own. Sadly the documentation is still missing :(

csarrazi · 2016-04-13T07:46:27Z

The only remaining part is the cookbook, which is not finalized. Indeed, the configuration sections at the end is not ready yet: Only a few yaml examples are ready, and the configuration for other formats (php, xml) is definitely not ready, as I generally do not use these.

csarrazi · 2016-04-16T07:33:24Z

Done. @javiereguiluz could you take a look at it?

csarrazi · 2016-04-16T07:33:55Z

By the way, this documentation is for version 2.8 and 3.0 of the Ldap component. Changes brought in 3.1 will be addressed in another PR.

javiereguiluz · 2016-04-16T08:16:30Z

cookbook/security/ldap.rst

+
+* Checking a user's password and fetching user information against an
+  LDAP server. This can be done using both the LDAP user provider and
+  either the LDAP form login or LDAP http basic authentication providers.


http -> HTTP

javiereguiluz · 2016-04-16T08:24:00Z

I left some unimportant comments but overall I like this documentation a lot: you went straight to the point, everything is clearly explained and there are a ton of useful examples. You did a truly amazing job here. Thanks!

HeahDude · 2016-04-16T12:48:00Z

components/ldap.rst

+The Ldap Component
+==================
+
+    The Ldap component provides a means to connect to an LDAP server (OpenLDAP or Active Directory).


It sounds weird to use an "a" with a plural, shouldn't it be "provides (the/some)? means"?

Actually, this is how the word means works. In its singular form, it still takes an s. :)

Also, as the Ldap component is not the only means to connect to an LDAP server, the article a is correct, here. :)

csarrazi · 2016-04-16T18:05:55Z

Comments corrected.

By the way, the PR for 3.1 will be quite small in comparison, as the only difference will be the description of the new way to define the ldap service. However, it first needs this PR to be merged in all branches (2.8, 3.0, master/3.1).

csarrazi · 2016-05-13T14:47:34Z

Are there still missing things here? I'd like to be able to work on adding the doc for version 3.1 of the Ldap component before the 3.1 release.

Ping @javiereguiluz

xabbuh · 2016-05-21T11:00:57Z

components/ldap.rst

+The :class:`Symfony\\Component\\Ldap\\LdapClient` class can be configured
+using the following options:
+
+* host: IP or hostname of the LDAP server


I would enclose the option names with literals (double backticks).

csarrazi · 2016-05-26T13:23:36Z

Anything else to do @xabbuh, @javiereguiluz?

javiereguiluz · 2016-05-26T13:27:41Z

@csarrazi nothing else for me ... except saying thank you for your great work!

I'm sure that doc maintainers will merge this soon. We want to document lots of things before the 3.1 release in 5 days.

csarrazi · 2016-05-26T15:56:37Z

Yeah. And this needs to be merged so I can update the docs for 3.1.

xabbuh · 2016-05-29T11:35:48Z

@javiereguiluz I counted your last comment as a +1 vote. So I am going to merge here.

xabbuh · 2016-05-29T11:36:33Z

@csarrazi Thanks for your work on this new feature!

This PR was merged into the 2.8 branch. Discussion ---------- [RFR] Documentation for the Ldap component | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.8, 3.0 | Fixed tickets | #6201 #5756 Commits ------- 305abb8 Added documentation for the Ldap component

csarrazi · 2016-05-29T13:41:58Z

You're welcome. I'll work on the 3.1 doc asap!

xabbuh · 2016-05-29T14:36:11Z

@csarrazi I merged your changes up into the 3.1 branch.

javiereguiluz reviewed Mar 29, 2016
View reviewed changes

csarrazi mentioned this pull request Apr 1, 2016

[Ldap] [Doc] Update README.md symfony/symfony#18408

Merged

csarrazi changed the title ~~[WIP] Documentation for the Ldap component~~ [RFR] Documentation for the Ldap component Apr 16, 2016

javiereguiluz reviewed Apr 16, 2016
View reviewed changes

HeahDude reviewed Apr 16, 2016
View reviewed changes

xabbuh reviewed May 21, 2016
View reviewed changes

Added documentation for the Ldap component

305abb8

xabbuh merged commit 305abb8 into symfony:2.8 May 29, 2016

csarrazi deleted the doc/ldap branch September 19, 2016 17:59

xabbuh added the Ldap label Jan 25, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RFR] Documentation for the Ldap component #6402

[RFR] Documentation for the Ldap component #6402

csarrazi commented Mar 27, 2016

javiereguiluz commented Mar 29, 2016

javiereguiluz Mar 29, 2016

csarrazi Mar 29, 2016

javiereguiluz Mar 29, 2016

csarrazi Mar 29, 2016

csarrazi commented Mar 29, 2016

csarrazi commented Mar 31, 2016

linaori commented Apr 13, 2016

csarrazi commented Apr 13, 2016

csarrazi commented Apr 16, 2016

csarrazi commented Apr 16, 2016

javiereguiluz Apr 16, 2016

csarrazi Apr 16, 2016

javiereguiluz commented Apr 16, 2016

HeahDude Apr 16, 2016 •

edited

Loading

csarrazi Apr 16, 2016

csarrazi commented Apr 16, 2016

csarrazi commented May 13, 2016

xabbuh May 21, 2016

csarrazi commented May 26, 2016

javiereguiluz commented May 26, 2016

csarrazi commented May 26, 2016

xabbuh commented May 29, 2016

xabbuh commented May 29, 2016 •

edited

Loading

csarrazi commented May 29, 2016

xabbuh commented May 29, 2016

[RFR] Documentation for the Ldap component #6402

[RFR] Documentation for the Ldap component #6402

Conversation

csarrazi commented Mar 27, 2016

javiereguiluz commented Mar 29, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csarrazi commented Mar 29, 2016

csarrazi commented Mar 31, 2016

linaori commented Apr 13, 2016

csarrazi commented Apr 13, 2016

csarrazi commented Apr 16, 2016

csarrazi commented Apr 16, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Apr 16, 2016

HeahDude Apr 16, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csarrazi commented Apr 16, 2016

csarrazi commented May 13, 2016

Choose a reason for hiding this comment

csarrazi commented May 26, 2016

javiereguiluz commented May 26, 2016

csarrazi commented May 26, 2016

xabbuh commented May 29, 2016

xabbuh commented May 29, 2016 • edited Loading

csarrazi commented May 29, 2016

xabbuh commented May 29, 2016

HeahDude Apr 16, 2016 •

edited

Loading

xabbuh commented May 29, 2016 •

edited

Loading